Skip to content

docs: enhace README with improved contribution guide and social links#42

Closed
Akash-Adhya wants to merge 2 commits intokeploy:mainfrom
Akash-Adhya:main
Closed

docs: enhace README with improved contribution guide and social links#42
Akash-Adhya wants to merge 2 commits intokeploy:mainfrom
Akash-Adhya:main

Conversation

@Akash-Adhya
Copy link
Copy Markdown

Description

This PR updates the README.md with:

  • Clearer step-by-step contribution guidelines
  • Proper formatting and code blocks for setup instructions
  • Official Keploy social links (LinkedIn, YouTube, Twitter)
  • A polished and welcoming tone for new contributors

Type of change

  • This change requires a documentation update

How Has This Been Tested?

Manually reviewed the rendered README on a markdown previewer and tested the cloned project setup using the documented instructions. Verified the formatting, clarity, and correctness of all updated sections.

No UI changes introduced.

...

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • New and existing unit tests pass locally with my changes (N/A for docs)
  • I have checked my code and corrected any misspellings
  • I have tagged the reviewers in a comment below in case my pull request is ready for a review
  • I have signed the commit message to agree to the Developer Certificate of Origin (DCO) by adding --signoff to my git commit command

@Akash-Adhya Akash-Adhya closed this by deleting the head repository Jul 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant